home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2001 May / SGI Freeware 2001 May - Disc 3.iso / dist / fw_apache.idb / usr / freeware / apache / include / ap_ctx.h.z / ap_ctx.h
Encoding:
C/C++ Source or Header  |  2001-01-10  |  3.9 KB  |  111 lines
  1. /* ====================================================================
  2.  * Copyright (c) 1998-2000 The Apache Group.  All rights reserved.
  3.  *
  4.  * Redistribution and use in source and binary forms, with or without
  5.  * modification, are permitted provided that the following conditions
  6.  * are met:
  7.  *
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer. 
  10.  *
  11.  * 2. Redistributions in binary form must reproduce the above copyright
  12.  *    notice, this list of conditions and the following disclaimer in
  13.  *    the documentation and/or other materials provided with the
  14.  *    distribution.
  15.  *
  16.  * 3. All advertising materials mentioning features or use of this
  17.  *    software must display the following acknowledgment:
  18.  *    "This product includes software developed by the Apache Group
  19.  *    for use in the Apache HTTP server project (http://www.apache.org/)."
  20.  *
  21.  * 4. The names "Apache Server" and "Apache Group" must not be used to
  22.  *    endorse or promote products derived from this software without
  23.  *    prior written permission. For written permission, please contact
  24.  *    apache@apache.org.
  25.  *
  26.  * 5. Products derived from this software may not be called "Apache"
  27.  *    nor may "Apache" appear in their names without prior written
  28.  *    permission of the Apache Group.
  29.  *
  30.  * 6. Redistributions of any form whatsoever must retain the following
  31.  *    acknowledgment:
  32.  *    "This product includes software developed by the Apache Group
  33.  *    for use in the Apache HTTP server project (http://www.apache.org/)."
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``AS IS'' AND ANY
  36.  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  37.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  38.  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE APACHE GROUP OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  41.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  42.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  43.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  44.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  45.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  46.  * OF THE POSSIBILITY OF SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Group and was originally based
  51.  * on public domain software written at the National Center for
  52.  * Supercomputing Applications, University of Illinois, Urbana-Champaign.
  53.  * For more information on the Apache Group and the Apache HTTP server
  54.  * project, please see <http://www.apache.org/>.
  55.  *
  56.  */
  57.  
  58. /*
  59. **  Generic Context Interface for Apache
  60. **  Written by Ralf S. Engelschall <rse@engelschall.com> 
  61. */
  62.  
  63. #ifdef EAPI
  64.  
  65. #ifndef AP_CTX_H
  66. #define AP_CTX_H
  67.  
  68. #ifndef FALSE
  69. #define FALSE 0
  70. #define TRUE  !FALSE
  71. #endif
  72.  
  73. /*
  74.  * Internal Context Record Definition
  75.  */
  76.  
  77. #define AP_CTX_MAX_ENTRIES 1024
  78.  
  79. typedef struct {
  80.     char *ce_key;
  81.     void *ce_val;
  82. } ap_ctx_entry;
  83.  
  84. typedef struct {
  85.     pool          *cr_pool;
  86.     ap_ctx_entry **cr_entry;
  87. } ap_ctx_rec;
  88.  
  89. typedef ap_ctx_rec ap_ctx;
  90.  
  91. /*
  92.  * Some convinience macros for storing _numbers_ 0...n in contexts, i.e.
  93.  * treating numbers as pointers but keeping track of the NULL return code of
  94.  * ap_ctx_get.
  95.  */
  96. #define AP_CTX_NUM2PTR(n) (void *)((unsigned int)(n)+1)
  97. #define AP_CTX_PTR2NUM(p) (unsigned int)(((char *)(p))-1)
  98.  
  99. /*
  100.  * Prototypes for Context Handling Functions
  101.  */
  102.  
  103. API_EXPORT(ap_ctx *)ap_ctx_new(pool *p);
  104. API_EXPORT(void)    ap_ctx_set(ap_ctx *ctx, char *key, void *val);
  105. API_EXPORT(void *)  ap_ctx_get(ap_ctx *ctx, char *key);
  106. API_EXPORT(ap_ctx *)ap_ctx_overlay(pool *p, ap_ctx *over, ap_ctx *base);
  107.  
  108. #endif /* AP_CTX_H */
  109.  
  110. #endif /* EAPI */
  111.